SWT.h

Go to the documentation of this file.

#ifndef _SWT_H
#define _SWT_H

/*
 ******************************************************************************
 * Defines, Macros and Typedefs 
 *****************************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BITS_IN_32
 #define BITS_IN_32  (32u)
#endif
#ifndef BITS_IN_16
 #define BITS_IN_16  (16u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

#define SWT_EN                 (0x00000001u)
#define SWT_DIS                (0x00000000u)
#define SWT_DEBUG_EN           (0x00000002u)
#define SWT_DEBUG_DIS          (0x00000000u)
#define SWT_STOP_EN            (0x00000004u)
#define SWT_STOP_DIS           (0x00000000u)
#define SWT_USES_OSCILLATOR    (0x00000008u)
#define SWT_SOFT_LOCK_EN       (0x00000010u)
#define SWT_SOFT_LOCK_DIS      (0x00000000u)
#define SWT_HARD_LOCK_EN       (0x00000020u)
#define SWT_HARD_LOCK_DIS      (0x00000000u)
#define SWT_GENERATE_ISR_EN    (0x00000040u)
#define SWT_GENERATE_ISR_DIS   (0x00000000u)
#define SWT_WINDOWED_MODE_EN   (0x00000080u)
#define SWT_WINDOWED_MODE_DIS  (0x00000000u)
#define SWT_RESET_WHEN_INVALID (0x00000100u)
#define SWT_IVOR_WHEN_INVALID  (0x00000000u)
#define SWT_RANDOM_KEY_EN      (0x00000200u)
#define SWT_RANDOM_KEY_DIS     (0x00000000u)

#define SWT_DEFAULT_MAP_SETTING (0xFF000000u)

/*** Function Macros ***/
/* This macro is needed to keep the watch-dog happy */
#define FEED_WATCHDOG() { \
  SWT.SR.R = (uint32_t)0xA602u; \
  SWT.SR.R = (uint32_t)0xB480u; \
}

/* This macro is needed to clear the Soft-lock in the module */
#define SWT_CLEAR_SOFT_LOCK() { \
  SWT.SR.R = (uint32_t)0xC520u; \
  SWT.SR.R = (uint32_t)0xD928u; \
}
/* This macro is used when configuring the module */
#define SWT_TIME_OUT_COUNTS(xx)  (xx)

/* This macro is used when configuring the module */
#define SWT_WINDOW_COUNTS(xx)  (xx)

/*** Enums ***/
enum SWT_LOCK_STATUS
{
  SWT_UNLOCKED = 0u, SWT_SOFT_LOCKED, SWT_HARD_LOCKED
};
/*** TypeDefs ***/
typedef union
{
  struct
  {
    uint32_t WindowCount;
    uint32_t TimeOutCount;
    uint32_t CR;
  }W;
  struct
  {
    uint32_t WindowCount;
    uint32_t TimeOutCount;
    uint32_t Reserved2:        23;
    uint32_t RandomKeyModeEn:  1;
    uint32_t ResetWhenInvalid: 1;
    uint32_t WindowModeEn:     1;
    uint32_t GenerateIsr:      1;
    uint32_t HardLockEn:       1;
    uint32_t SoftLockEn:       1;
    uint32_t Reserved:         1;
    uint32_t StopEn:           1;
    uint32_t DebugEn:          1;
    uint32_t Enable:           1;
    
  }P;
  
} SWTConfig_t;
/*
 ******************************************************************************
 * Declarations 
 *****************************************************************************/
/*** Extern ***/

/*** Globals ***/

/*** Static Globals ***/

/*
 ******************************************************************************
 * Function Prototypes 
 *****************************************************************************/
 /*
 ******************************************************************************
 *
 * Function:          u16fnConfigSoftwareWatchDog()
 *
 */
uint16_t u16fnConfigSoftwareWatchDog(const SWTConfig_t* ptMySWTConfig);
/*
******************************************************************************
*
* Function:          u16fnSWTLockStatus()
*
*/
static uint16_t u16fnSWTLockStatus(void);
#endif /* _FILENAME_H */